/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.actions.annotations

import com.android.tools.idea.projectsystem.AndroidProjectSystem
import com.android.tools.idea.projectsystem.Token
import com.intellij.openapi.extensions.ExtensionPointName
import com.intellij.openapi.project.Project
import com.intellij.usageView.UsageInfo

interface InferAnnotationsToken<P : AndroidProjectSystem> : Token {
  /**
   * Check that the project is correctly set up for annotations, making any changes if necessary.  If no changes are necessary, simply
   * return `true`.  If changes to the project are necessary, proceed to make them appropriately; on success, run [runnable]; whether
   * changes are successful or not, return `false`.
   */
  fun checkDependencies(project: Project, usageInfos: Array<UsageInfo>, runnable: Runnable): Boolean

  companion object {
    val EP_NAME = ExtensionPointName<InferAnnotationsToken<AndroidProjectSystem>>("com.android.tools.idea.actions.annotations.inferAnnotationsToken")
  }
}